<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
ContainmentIndex (uimaFIT 1.3.0 API)
</TITLE>


<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ContainmentIndex (uimaFIT 1.3.0 API)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ContainmentIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/uimafit/util/CasUtil.html" title="class in org.uimafit.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/uimafit/util/ContainmentIndex.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ContainmentIndex.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.uimafit.util</FONT>
<BR>
Class ContainmentIndex&lt;S extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,U extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt;</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.uimafit.util.ContainmentIndex&lt;S,U&gt;</B>
</PRE>
<DL>
<DT><DT><B>Type Parameters:</B><DD><CODE>S</CODE> - covering type.<DD><CODE>U</CODE> - covered type.</DL>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.46"><B>ContainmentIndex&lt;S extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,U extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt;</B></A><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>

<P>
Create a fast way of repeatedly checking whether instances of one type are contained within the
 boundaries on another type.
<P>

<P>
<DL>
<DT><B>Author:</B></DT>
  <DD>Richard Eckart de Castilho</DD>
</DL>
<HR>

<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->

<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#ContainmentIndex(org.apache.uima.cas.CAS, org.apache.uima.cas.Type, org.apache.uima.cas.Type, org.uimafit.util.ContainmentIndex.Type)">ContainmentIndex</A></B>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/CAS.html?is-external=true" title="class or interface in org.apache.uima.cas">CAS</A>&nbsp;cas,
                                 <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aSuper,
                                 <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aUnder,
                                 <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new index on the given JCas using the specified two types.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#containedIn(S)">containedIn</A></B>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&nbsp;aSuper)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get all instances of the covered type contained within the boundaries of the specified
 instance of the covering type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#containing(U)">containing</A></B>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get all instances of the covering type containing the the specified instance of the covered
 type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="class in org.uimafit.util">ContainmentIndex</A>&lt;<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#create(org.apache.uima.cas.CAS, org.apache.uima.cas.Type, org.apache.uima.cas.Type, org.uimafit.util.ContainmentIndex.Type)">create</A></B>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/CAS.html?is-external=true" title="class or interface in org.apache.uima.cas">CAS</A>&nbsp;cas,
             <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aSuper,
             <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aUnder,
             <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory method to create an index instead of using the constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE>&lt;A extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,B extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt; 
<BR>
<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="class in org.uimafit.util">ContainmentIndex</A>&lt;A,B&gt;</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#create(org.apache.uima.jcas.JCas, java.lang.Class, java.lang.Class, org.uimafit.util.ContainmentIndex.Type)">create</A></B>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/jcas/JCas.html?is-external=true" title="class or interface in org.apache.uima.jcas">JCas</A>&nbsp;aJcas,
             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;A&gt;&nbsp;aSuper,
             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;B&gt;&nbsp;aUnder,
             <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory method to create an index instead of using the constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#isContainedIn(S, U)">isContainedIn</A></B>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&nbsp;aSuper,
                           <A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the given covered type is contained in the specified covering type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/util/ContainmentIndex.html#isContainedInAny(U)">isContainedInAny</A></B>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the given covered type is contained in any instance of the covering type.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ContainmentIndex(org.apache.uima.cas.CAS, org.apache.uima.cas.Type, org.apache.uima.cas.Type, org.uimafit.util.ContainmentIndex.Type)"><!-- --></A><H3>
ContainmentIndex</H3>
<PRE>
public <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.69"><B>ContainmentIndex</B></A>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/CAS.html?is-external=true" title="class or interface in org.apache.uima.cas">CAS</A>&nbsp;cas,
                        <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aSuper,
                        <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aUnder,
                        <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</PRE>
<DL>
<DD>Create a new index on the given JCas using the specified two types. The last argument
 indicates in which directions lookups to the index will be made.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>cas</CODE> - the working JCas.<DD><CODE>aSuper</CODE> - the covering type.<DD><CODE>aUnder</CODE> - the covered type.<DD><CODE>aType</CODE> - the indexing strategy.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="containedIn(org.apache.uima.cas.text.AnnotationFS)"><!-- --></A><A NAME="containedIn(S)"><!-- --></A><H3>
containedIn</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&gt; <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.110"><B>containedIn</B></A>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&nbsp;aSuper)</PRE>
<DL>
<DD>Get all instances of the covered type contained within the boundaries of the specified
 instance of the covering type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>aSuper</CODE> - a covering type instance.
<DT><B>Returns:</B><DD>a collection of covered type instances.</DL>
</DD>
</DL>
<HR>

<A NAME="containing(org.apache.uima.cas.text.AnnotationFS)"><!-- --></A><A NAME="containing(U)"><!-- --></A><H3>
containing</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&gt; <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.128"><B>containing</B></A>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</PRE>
<DL>
<DD>Get all instances of the covering type containing the the specified instance of the covered
 type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>aUnder</CODE> - a covered type instance.
<DT><B>Returns:</B><DD>a collection of covering type instances.</DL>
</DD>
</DL>
<HR>

<A NAME="isContainedIn(org.apache.uima.cas.text.AnnotationFS,org.apache.uima.cas.text.AnnotationFS)"><!-- --></A><A NAME="isContainedIn(S, U)"><!-- --></A><H3>
isContainedIn</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.146"><B>isContainedIn</B></A>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">S</A>&nbsp;aSuper,
                             <A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</PRE>
<DL>
<DD>Checks if the given covered type is contained in the specified covering type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>aSuper</CODE> - the covering type instance.<DD><CODE>aUnder</CODE> - the covered type instance.
<DT><B>Returns:</B><DD>whether the covered instance is contained in the covering instance.</DL>
</DD>
</DL>
<HR>

<A NAME="isContainedInAny(org.apache.uima.cas.text.AnnotationFS)"><!-- --></A><A NAME="isContainedInAny(U)"><!-- --></A><H3>
isContainedInAny</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.157"><B>isContainedInAny</B></A>(<A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="type parameter in ContainmentIndex">U</A>&nbsp;aUnder)</PRE>
<DL>
<DD>Checks if the given covered type is contained in any instance of the covering type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>aUnder</CODE> - the covered type instance.
<DT><B>Returns:</B><DD>whether the covered instance is contained in any instance of the covering type.</DL>
</DD>
</DL>
<HR>

<A NAME="create(org.apache.uima.jcas.JCas, java.lang.Class, java.lang.Class, org.uimafit.util.ContainmentIndex.Type)"><!-- --></A><H3>
create</H3>
<PRE>
public static &lt;A extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,B extends <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt; <A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="class in org.uimafit.util">ContainmentIndex</A>&lt;A,B&gt; <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.181"><B>create</B></A>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/jcas/JCas.html?is-external=true" title="class or interface in org.apache.uima.jcas">JCas</A>&nbsp;aJcas,
                                                                                           <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;A&gt;&nbsp;aSuper,
                                                                                           <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;B&gt;&nbsp;aUnder,
                                                                                           <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</PRE>
<DL>
<DD>Factory method to create an index instead of using the constructor. This makes used of Java's
 type inference capabilities and results in less verbose code.
<P>
<DD><DL>
<DT><B>Type Parameters:</B><DD><CODE>A</CODE> - covering type.<DD><CODE>B</CODE> - covered type.<DT><B>Parameters:</B><DD><CODE>aJcas</CODE> - the working JCas.<DD><CODE>aSuper</CODE> - the covering type.<DD><CODE>aUnder</CODE> - the covered type.<DD><CODE>aType</CODE> - the indexing strategy.
<DT><B>Returns:</B><DD>the index instance.</DL>
</DD>
</DL>
<HR>

<A NAME="create(org.apache.uima.cas.CAS, org.apache.uima.cas.Type, org.apache.uima.cas.Type, org.uimafit.util.ContainmentIndex.Type)"><!-- --></A><H3>
create</H3>
<PRE>
public static <A HREF="../../../org/uimafit/util/ContainmentIndex.html" title="class in org.uimafit.util">ContainmentIndex</A>&lt;<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>,<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/text/AnnotationFS.html?is-external=true" title="class or interface in org.apache.uima.cas.text">AnnotationFS</A>&gt; <A HREF="../../../src-html/org/uimafit/util/ContainmentIndex.html#line.201"><B>create</B></A>(<A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/CAS.html?is-external=true" title="class or interface in org.apache.uima.cas">CAS</A>&nbsp;cas,
                                                                 <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aSuper,
                                                                 <A HREF="http://uima.apache.org/d/uimaj-2.3.1/api/org/apache/uima/cas/Type.html?is-external=true" title="class or interface in org.apache.uima.cas">Type</A>&nbsp;aUnder,
                                                                 <A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util">ContainmentIndex.Type</A>&nbsp;aType)</PRE>
<DL>
<DD>Factory method to create an index instead of using the constructor. This makes used of Java's
 type inference capabilities and results in less verbose code.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cas</CODE> - the working JCas.<DD><CODE>aSuper</CODE> - the covering type.<DD><CODE>aUnder</CODE> - the covered type.<DD><CODE>aType</CODE> - the indexing strategy.
<DT><B>Returns:</B><DD>the index instance.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ContainmentIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/uimafit/util/CasUtil.html" title="class in org.uimafit.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/uimafit/util/ContainmentIndex.Type.html" title="enum in org.uimafit.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/uimafit/util/ContainmentIndex.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ContainmentIndex.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &#169; 2012. All Rights Reserved.
</BODY>
</HTML>
